home *** CD-ROM | disk | FTP | other *** search
/ STraTOS 1997 April & May / STraTOS 1 - 1997 April & May.iso / CD01 / INTERNET / SITES / RAND / STG13E.ZIP / ST-GUIDE / READ.ME < prev    next >
Encoding:
Text File  |  1995-05-12  |  4.3 KB  |  96 lines
  1. ---------------------------------------------------------------------------
  2. README for ST-Guide v1.3e (English Release 5)                 12th May 1995
  3. ===========================================================================
  4. Important!
  5. Previous versions were not given normal version nmbers but instead titled: 
  6. Release 1, Release 2, Release 3 and Release 4.
  7. From this release normal version numbers have been adopted so this v1.3 
  8. supercedes Release 4 (and is effectively Release 5).
  9.  
  10. Read ST-GUIDE.CHG for details of the latest changes.
  11.  
  12. ST-Guide consists of two archives:
  13.  
  14. STGUIxxE.LZH:    Contains ST-Guide, HCP, HypFind, STool and RefLink
  15. STGUTxxE.LZH:    Contains 1st-Conv, PC-Conv, MAN2STG with C source code 
  16.                  along with HELP_RC, HELPDISK, HypTree and others!
  17.  
  18. We've included the source code so other programmers can debug or extend 
  19. the converters. Please let me know and send me a copy of any changes you 
  20. make so I can make sure everbody has access to the latest and optimum 
  21. versions at all times.
  22.  
  23. ---------------------------------------------------------------------------
  24. Installation guide
  25. ===========================================================================
  26.  
  27. To minimise the risk of other software affecting the installation of 
  28. ST-Guide perform the installation after a reboot on a 'clean' minimum 
  29. system!
  30.  
  31. Extracting the archives
  32. -----------------------
  33. Extract the contents of the archives OR copy the contents of the master 
  34. disk onto the root directory of your boot partition/disk.
  35.  
  36. Either method should preserve the directory structure and ensures ST-GUIDE 
  37. can locate its files. Double check to ensure ST-GUIDE.ACC and ST-GUIDE.INF 
  38. reside in the root directory of the boot partition or disk.
  39.  
  40. Configuring ST-Guide
  41. --------------------
  42. Using a text editor (eg Everest) load ST-GUIDE.INF and carefully read 
  43. through the options. Each option is described in detail followed by the 
  44. option line itself. Lines preceded with a '#' character are NOT currently 
  45. active.
  46.  
  47. It's important the path entries are correct otherwise ST-Guide won't be 
  48. able to find its files:
  49.  
  50. PATHS:   The path where HYP files are located, more than one path can be 
  51.          entered, use the ';' character to seperate paths.
  52. HYPFOLD: The default path used by the file selector and HCP.
  53. HYPTOP:  The default hypertext loaded when ST-GUIDE is called without 
  54.          parameters.
  55. REF:     The path to the ALL.REF file, which may already be listed in the 
  56.          PATHS variable. It's not needed during installation and can be 
  57.          added later.
  58. HCP:     The path to the compiler, HCP.TTP.
  59.  
  60. ST-GUIDE should not be renamed as some applications which offer on-line 
  61. help may not be able to find it.
  62.  
  63. Managing your hypertexts
  64. ------------------------
  65. Each hypertext consists of a HYP and a REF file. The HYP file contains the 
  66. compiled hypertext and the REF file contains the references defined in the 
  67. hypertext.
  68. Using REFLINK.TTP it's possible to combine the references contained in 
  69. each REF file into a single ALL.REF file.
  70. There are several ways of adding the contents of an individual REF file to 
  71. ALL.REF:
  72. a) Install REFLINK.TTP as an application for '*.REF' files using the 
  73.    desktop. After installation a double click on any REF file on the 
  74.    desktop will call REFLINK.TTP and add the contents of the REF file to 
  75.    an ALL.REF file located using the REF path in ST-GUIDE.INF.
  76. b) Drag a REF file/s onto REFLINK.TTP.
  77. c) Run REFLINK.TTP and manually enter the path to the desired REF file.
  78.  
  79. Catalogue your collection
  80. -------------------------
  81. Using STOOL.TOS it's possible to automatically catalogue all your 
  82. hypertexts thematically. This does however depend on the author of the 
  83. hypertext including the necessary infomation in the hypertext header.
  84.  
  85. On starting STOOL.TOS each of the paths entered in the ST-GUIDE.INF PATH 
  86. entry is searched for HYP format hypertexts and creates a hypertext 
  87. called CATALOG.HYP. this can be loaded via the 'Open' option from the 
  88. 'Extras' menu in ST-GUIDE.ACC or installed as the default hypertext in 
  89. ST-GUIDE.INF.
  90.                              
  91. Finally
  92. -------
  93. Reboot your computer and we wish you every success using ST-Guide.
  94. ---------------------------------------------------------------------------
  95. EOF
  96.